﻿#region Copyright and license information
// Copyright 2001-2009 Stephen Colebourne
// Copyright 2009-2011 Jon Skeet
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#endregion

using System;
using System.Xml;

namespace NodaTime.Xml
{
    /// <summary>
    ///   Extends the <see cref="XmlWriter"/> to write NodaTime types. Can NOT be implemented.
    /// </summary>
    /// <remarks>
    ///   I really want to override to XmlWriter.WriteValue for the NodaTime types.  However, since it implements
    ///   WriteValue(object) any extension to the method is ignored.
    /// </remarks>
    ///  <example>
    ///   The work-around to the above restriction, is:
    ///   <code>
    ///     writer.WriteString(NodaXmlConvert.ToString(someNodaTimeType));
    ///   </code>
    ///  </example>
    /// <see cref="NodaXmlConvert"/>
    public static class XmlWriterExtensions // TODO: Extend with XmlWriter.WriteNodaValue or check XmlWriter.WriteValue for a conversion hook.
    {
        
#if false // Can not be extended!
        /// <summary>
        ///   Writes an <see cref="Instant"/> value.
        /// </summary>
        /// <param name="writer">A <see cref="XmlWriter"/> that is being extended.</param>
        /// <param name="instant">An <see cref="Instant"/> to write.</param>
        public static void WriteValue(this XmlWriter writer, Instant instant)
        {
            writer.WriteString(NodaXmlConvert.ToString(instant));
        }
#endif
    }
}
